Inside Macintosh: QuickTime Components /

Chapter 5 - Sequence Grabber Components / Sequence Grabber Components Reference

Sequence Grabber Component Functions / Working With Sequence Grabber Settings

SGSettingsDialog

You may cause the sequence grabber to display its settings dialog box to the user by calling the SGSettingsDialog function. The user can use this dialog box to specify the configuration of a sequence grabber channel.

pascal ComponentResult SGSettingsDialog (SeqGrabComponent s, 
                      SGChannel c, short numPanels, 
                      Component *panelList, long flags, 
                      SGModalFilterProcPtr proc, long procRefNum);

s

Specifies the component instance that identifies your connection to the sequence grabber component. You obtain this value from the Component Manager's OpenDefaultComponent or OpenComponent function.

c

Identifies the channel to be configured. You provide your
connection identifier. You connect to a channel component by calling the SGNewChannel or SGNewChannelFromComponent function, discussed on page 5-29 and page 5-30, respectively.

numPanels

Specifies the number of panel components to be listed in the panel component pop-up menu. You specify the panel components with the panelList parameter. You may use these parameters to limit the user's choice of panel components. If you set this parameter to 0 and
the panelList parameter to nil, the sequence grabber lists all available panel components.

panelList

Contains a pointer to an array of component identifiers. The sequence grabber presents only these components in the panel component pop-up menu. You specify the number of identifiers in the array with the numPanels parameter. If you set this parameter to nil, the sequence grabber lists all available panel components.

flags

Reserved for Apple Computer. Set this parameter to 0.

proc

Specifies an event filter function. Because the sequence grabber's settings dialog box is a movable modal dialog box, you must supply an event filter function to process update events in your window. The interface that your filter function must support is described in "Application-Defined Functions" beginning on page 5-107.

procRefNum

Contains a reference constant for use by your filter function.

IMPORTANT

Because the settings dialog box is a movable modal dialog box, you must provide an event filter function.

DESCRIPTION

The SGSettingsDialog function instructs the sequence grabber to display its settings dialog box to the user. The sequence grabber works with one or more panel components to configure a specified channel component.

If the user clicks OK and the settings are acceptable to the panel and channel components, this function returns a result code of noErr. Because the user may change several channel configuration parameters, your application should retrieve new configuration information from the channel so that you can update any values you save, such as the channel's display boundaries or the channel device. In particular, the video rectangle for the channels may be adjusted.

RESULT CODE

userCanceledErr

-128

User canceled the dialog

SEE ALSO

You may retrieve or set the configuration of one or more channel components by using the SGGetSettings (described in the next section), SGSetSettings (described on page 5-48), SGGetChannelSettings (described on page 5-49), or SGSetChannelSettings function (described on page 5-50).

Main | Top of Section | What's New | Apple Computer, Inc. | Find It | Feedback | Help